<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>CMSIS DSP Software Library</title>
<title>CMSIS-DSP: CMSIS DSP Software Library</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 46px;">
  <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">CMSIS-DSP
   &#160;<span id="projectnumber">Version 1.8.0</span>
   </div>
   <div id="projectbrief">CMSIS DSP Software Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
    <ul class="tablist">
      <script type="text/javascript">
		<!--
		writeComponentTabs.call(this);
		//-->
      </script>
	  </ul>
</div>
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('index.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="PageDoc"><div class="header">
  <div class="headertitle">
<div class="title">CMSIS DSP Software Library </div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><h2><a class="anchor" id="autotoc_md0"></a>
Introduction</h2>
<p>This user manual describes the CMSIS DSP software library, a suite of common signal processing functions for use on Cortex-M and Cortex-A processor based devices.</p>
<p>The library is divided into a number of functions each covering a specific category:</p><ul>
<li>Basic math functions</li>
<li>Fast math functions</li>
<li>Complex math functions</li>
<li>Filtering functions</li>
<li>Matrix functions</li>
<li>Transform functions</li>
<li>Motor control functions</li>
<li>Statistical functions</li>
<li>Support functions</li>
<li>Interpolation functions</li>
<li>Support Vector Machine functions (SVM)</li>
<li>Bayes classifier functions</li>
<li>Distance functions</li>
</ul>
<p>The library has generally separate functions for operating on 8-bit integers, 16-bit integers, 32-bit integer and 32-bit floating-point values.</p>
<h2><a class="anchor" id="autotoc_md1"></a>
Using the Library</h2>
<p>The library installer contains prebuilt versions of the libraries in the <code>Lib</code> folder.</p>
<p>Here is the list of pre-built libraries :</p><ul>
<li>arm_cortexM7lfdp_math.lib (Cortex-M7, Little endian, Double Precision Floating Point Unit)</li>
<li>arm_cortexM7bfdp_math.lib (Cortex-M7, Big endian, Double Precision Floating Point Unit)</li>
<li>arm_cortexM7lfsp_math.lib (Cortex-M7, Little endian, Single Precision Floating Point Unit)</li>
<li>arm_cortexM7bfsp_math.lib (Cortex-M7, Big endian and Single Precision Floating Point Unit on)</li>
<li>arm_cortexM7l_math.lib (Cortex-M7, Little endian)</li>
<li>arm_cortexM7b_math.lib (Cortex-M7, Big endian)</li>
<li>arm_cortexM4lf_math.lib (Cortex-M4, Little endian, Floating Point Unit)</li>
<li>arm_cortexM4bf_math.lib (Cortex-M4, Big endian, Floating Point Unit)</li>
<li>arm_cortexM4l_math.lib (Cortex-M4, Little endian)</li>
<li>arm_cortexM4b_math.lib (Cortex-M4, Big endian)</li>
<li>arm_cortexM3l_math.lib (Cortex-M3, Little endian)</li>
<li>arm_cortexM3b_math.lib (Cortex-M3, Big endian)</li>
<li>arm_cortexM0l_math.lib (Cortex-M0 / Cortex-M0+, Little endian)</li>
<li>arm_cortexM0b_math.lib (Cortex-M0 / Cortex-M0+, Big endian)</li>
<li>arm_ARMv8MBLl_math.lib (Armv8-M Baseline, Little endian)</li>
<li>arm_ARMv8MMLl_math.lib (Armv8-M Mainline, Little endian)</li>
<li>arm_ARMv8MMLlfsp_math.lib (Armv8-M Mainline, Little endian, Single Precision Floating Point Unit)</li>
<li>arm_ARMv8MMLld_math.lib (Armv8-M Mainline, Little endian, DSP instructions)</li>
<li>arm_ARMv8MMLldfsp_math.lib (Armv8-M Mainline, Little endian, DSP instructions, Single Precision Floating Point Unit)</li>
</ul>
<p>The library functions are declared in the public file <code><a class="el" href="arm__math_8h.html">arm_math.h</a></code> which is placed in the <code>Include</code> folder. Simply include this file and link the appropriate library in the application and begin calling the library functions. The Library supports single public header file <code> <a class="el" href="arm__math_8h.html">arm_math.h</a></code> for Cortex-M cores with little endian and big endian. Same header file will be used for floating point unit(FPU) variants.</p>
<h2><a class="anchor" id="autotoc_md2"></a>
Examples</h2>
<p>The library ships with a number of examples which demonstrate how to use the library functions.</p>
<h2><a class="anchor" id="autotoc_md3"></a>
Toolchain Support</h2>
<p>The library is now tested on Fast Models building with cmake. Core M0, M7, A5 are tested.</p>
<h2><a class="anchor" id="autotoc_md4"></a>
Building the Library</h2>
<p>The library installer contains a project file to rebuild libraries on MDK toolchain in the <code>CMSIS\DSP\Projects\ARM</code> folder.</p><ul>
<li>arm_cortexM_math.uvprojx</li>
</ul>
<p>The libraries can be built by opening the arm_cortexM_math.uvprojx project in MDK-ARM, selecting a specific target, and defining the optional preprocessor macros detailed above.</p>
<p>There is also a work in progress cmake build. The README file is giving more details.</p>
<h2><a class="anchor" id="autotoc_md5"></a>
Preprocessor Macros</h2>
<p>Each library project have different preprocessor macros.</p>
<ul>
<li>ARM_MATH_BIG_ENDIAN:</li>
</ul>
<p>Define macro ARM_MATH_BIG_ENDIAN to build the library for big endian targets. By default library builds for little endian targets.</p>
<ul>
<li>ARM_MATH_MATRIX_CHECK:</li>
</ul>
<p>Define macro ARM_MATH_MATRIX_CHECK for checking on the input and output sizes of matrices</p>
<ul>
<li>ARM_MATH_ROUNDING:</li>
</ul>
<p>Define macro ARM_MATH_ROUNDING for rounding on support functions</p>
<ul>
<li>ARM_MATH_LOOPUNROLL:</li>
</ul>
<p>Define macro ARM_MATH_LOOPUNROLL to enable manual loop unrolling in DSP functions</p>
<ul>
<li>ARM_MATH_NEON:</li>
</ul>
<p>Define macro ARM_MATH_NEON to enable Neon versions of the DSP functions. It is not enabled by default when Neon is available because performances are dependent on the compiler and target architecture.</p>
<ul>
<li>ARM_MATH_NEON_EXPERIMENTAL:</li>
</ul>
<p>Define macro ARM_MATH_NEON_EXPERIMENTAL to enable experimental Neon versions of of some DSP functions. Experimental Neon versions currently do not have better performances than the scalar versions.</p>
<ul>
<li>ARM_MATH_HELIUM:</li>
</ul>
<p>It implies the flags ARM_MATH_MVEF and ARM_MATH_MVEI and ARM_MATH_FLOAT16.</p>
<ul>
<li>ARM_MATH_MVEF:</li>
</ul>
<p>Select Helium versions of the f32 algorithms. It implies ARM_MATH_FLOAT16 and ARM_MATH_MVEI.</p>
<ul>
<li>ARM_MATH_MVEI:</li>
</ul>
<p>Select Helium versions of the int and fixed point algorithms.</p>
<ul>
<li>ARM_MATH_FLOAT16:</li>
</ul>
<p>Float16 implementations of some algorithms (Requires MVE extension).</p>
<hr  />
 <h2><a class="anchor" id="autotoc_md6"></a>
CMSIS-DSP in ARM::CMSIS Pack</h2>
<p>The following files relevant to CMSIS-DSP are present in the <b>ARM::CMSIS</b> Pack directories: </p><table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadNone">File/Folder </th><th class="markdownTableHeadNone">Content  </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone"><b>CMSIS\Documentation\DSP</b>  </td><td class="markdownTableBodyNone">This documentation  </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone"><b>CMSIS\DSP\DSP_Lib_TestSuite</b>  </td><td class="markdownTableBodyNone">DSP_Lib test suite  </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone"><b>CMSIS\DSP\Examples</b>  </td><td class="markdownTableBodyNone">Example projects demonstrating the usage of the library functions  </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone"><b>CMSIS\DSP\Include</b>  </td><td class="markdownTableBodyNone">DSP_Lib include files  </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone"><b>CMSIS\DSP\Lib</b>  </td><td class="markdownTableBodyNone">DSP_Lib binaries  </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone"><b>CMSIS\DSP\Projects</b>  </td><td class="markdownTableBodyNone">Projects to rebuild DSP_Lib binaries  </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone"><b>CMSIS\DSP\Source</b>  </td><td class="markdownTableBodyNone">DSP_Lib source files  </td></tr>
</table>
<hr  />
 <h2><a class="anchor" id="autotoc_md7"></a>
Revision History of CMSIS-DSP</h2>
<p>Please refer to <a class="el" href="ChangeLog_pg.html">Revision History of CMSIS-DSP</a>. </p>
</div></div><!-- PageDoc -->
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Generated on Tue Mar 17 2020 15:01:25 for CMSIS-DSP Version 1.8.0 by Arm Ltd. All rights reserved.
	<!--
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 
	-->
	</li>
  </ul>
</div>
</body>
</html>
